<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

	<title>Module: RConfig::Constants</title>

	<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />

	<script src="../js/jquery.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="../js/thickbox-compressed.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="../js/quicksearch.js" type="text/javascript"
		charset="utf-8"></script>
	<script src="../js/darkfish.js" type="text/javascript"
		charset="utf-8"></script>

</head>
<body class="module">

	<div id="metadata">
		<div id="home-metadata">
			<div id="home-section" class="section">
        <h3 class="section-header">
          <a href="../index.html">Home</a>
          <a href="../index.html#classes">Classes</a>
          <a href="../index.html#methods">Methods</a>
        </h3>
			</div>
		</div>

		<div id="file-metadata">
			<div id="file-list-section" class="section">
				<h3 class="section-header">In Files</h3>
				<div class="section-body">
					<ul>
					
						<li><a href="../lib/rconfig/constants_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
							class="thickbox" title="lib/rconfig/constants.rb">lib/rconfig/constants.rb</a></li>
					
					</ul>
				</div>
			</div>

			
		</div>

		<div id="class-metadata">

			<!-- Parent Class -->
			

			<!-- Namespace Contents -->
			

			<!-- Method Quickref -->
			

			<!-- Included Modules -->
			
		</div>

		<div id="project-metadata">
			
			
			<div id="fileindex-section" class="section project-section">
				<h3 class="section-header">Files</h3>
				<ul>
				
					<li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
				
				</ul>
			</div>
			

			<div id="classindex-section" class="section project-section">
				<h3 class="section-header">Class Index
					<span class="search-toggle"><img src="../images/find.png"
						height="16" width="16" alt="[+]"
						title="show/hide quicksearch" /></span></h3>
				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
				<fieldset>
					<legend>Quicksearch</legend>
					<input type="text" name="quicksearch" value=""
						class="quicksearch-field" />
				</fieldset>
				</form>

				<ul class="link-list">
				
					<li><a href="../RConfig.html">RConfig</a></li>
				
					<li><a href="../RConfig/Callbacks.html">RConfig::Callbacks</a></li>
				
					<li><a href="../RConfig/Cascade.html">RConfig::Cascade</a></li>
				
					<li><a href="../RConfig/Config.html">RConfig::Config</a></li>
				
					<li><a href="../RConfig/ConfigError.html">RConfig::ConfigError</a></li>
				
					<li><a href="../RConfig/Constants.html">RConfig::Constants</a></li>
				
					<li><a href="../RConfig/CoreMethods.html">RConfig::CoreMethods</a></li>
				
					<li><a href="../RConfig/DisabledLogger.html">RConfig::DisabledLogger</a></li>
				
					<li><a href="../RConfig/Exceptions.html">RConfig::Exceptions</a></li>
				
					<li><a href="../RConfig/Generators.html">RConfig::Generators</a></li>
				
					<li><a href="../RConfig/Generators/InstallGenerator.html">RConfig::Generators::InstallGenerator</a></li>
				
					<li><a href="../RConfig/InvalidLoadPathError.html">RConfig::InvalidLoadPathError</a></li>
				
					<li><a href="../RConfig/LoadPaths.html">RConfig::LoadPaths</a></li>
				
					<li><a href="../RConfig/PropertiesFile.html">RConfig::PropertiesFile</a></li>
				
					<li><a href="../RConfig/Reload.html">RConfig::Reload</a></li>
				
					<li><a href="../RConfig/Settings.html">RConfig::Settings</a></li>
				
					<li><a href="../RConfig/Utils.html">RConfig::Utils</a></li>
				
					<li><a href="../Array.html">Array</a></li>
				
					<li><a href="../Hash.html">Hash</a></li>
				
					<li><a href="../NilClass.html">NilClass</a></li>
				
					<li><a href="../String.html">String</a></li>
				
				</ul>
				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
			</div>

			
		</div>
	</div>

	<div id="documentation">
		<h1 class="module">RConfig::Constants</h1>

		<div id="description">
			
		</div>

		<!-- Constants -->
		
		<div id="constants-list" class="section">
			<h3 class="section-header">Constants</h3>
			<dl>
			
				<dt><a name="CONFIG_ROOT">CONFIG_ROOT</a></dt>
				
				<dd class="description"><p>
Sets <a href="Constants.html#CONFIG_ROOT">CONFIG_ROOT</a> to
RAILS_ROOT/config unless it has already been defined (i.e. in rails env, or
calling ruby app).
</p></dd>
				
			
				<dt><a name="ENV_TIER">ENV_TIER</a></dt>
				
				<dd class="description"><p>
ENV TIER i.e. (development, integration, staging, or production) Defaults
to RAILS_ENV if running in Rails, otherwise, it checks if
ENV[&#8216;TIER&#8217;] is present. If not, it assumes production.
</p></dd>
				
			
				<dt><a name="YML_FILE_TYPES">YML_FILE_TYPES</a></dt>
				
				<dd class="description"><p>
yml, yaml => yaml files, parsable by YAML library
</p></dd>
				
			
				<dt><a name="XML_FILE_TYPES">XML_FILE_TYPES</a></dt>
				
				<dd class="description"><p>
xml => self-explanatory
</p></dd>
				
			
				<dt><a name="CNF_FILE_TYPES">CNF_FILE_TYPES</a></dt>
				
				<dd class="description"><p>
conf, properties => <key=value> based config files  
</p></dd>
				
			
				<dt><a name="CONFIG_FILE_TYPES">CONFIG_FILE_TYPES</a></dt>
				
				<dd class="description"><p>
The type of file used for config. Valid choices include (yml, yaml, xml,
conf, config, properties)  
</p></dd>
				
			
				<dt><a name="HOSTNAME">HOSTNAME</a></dt>
				
				<dd class="description"><p>
Use CONFIG_HOSTNAME environment variable to test host-based configurations.
</p></dd>
				
			
				<dt><a name="HOSTNAME_SHORT">HOSTNAME_SHORT</a></dt>
				
				<dd class="description"><p>
Short Hostname: removes all chars from <a
href="Constants.html#HOSTNAME">HOSTNAME</a>, after first &#8220;.&#8221;
Used to specify machine-specific config files.
</p></dd>
				
			
				<dt><a name="SUFFIXES">SUFFIXES</a></dt>
				
				<dd class="description"><p>
This is an array of filename suffixes facilitates cascading configuration
overrides (i.e. &#8216;services_local&#8217;,
&#8216;services_development&#8217;). These files get loaded in the order of
the array. Meaning the last file loaded overrides everything before it. So
config files suffixed with hostname has the highest precedence, and
therefore overrides everything. Example: 
</p>
<pre>
         database_local.yml overrides database.yml
         database_staging.yml overrides database_local.yml
         database_appsvr01.yml overrides database_integration.yml</pre></dd>
				
			
				<dt><a name="EMPTY_ARRAY">EMPTY_ARRAY</a></dt>
				
				<dd class="description"><p>
Used in place of undefined but expected arrays, to prevent creating a bunch
of unecesary arrays in memory. See ConfigCore.fire_on_load
</p></dd>
				
			
			</dl>
		</div>
		

		<!-- Attributes -->
		

		<!-- Methods -->
		

	</div>


	<div id="rdoc-debugging-section-dump" class="debugging-section">
	
		<p>Disabled; run with --debug to generate this.</p>
	
	</div>

	<div id="validator-badges">
		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
			Rdoc Generator</a> 1.1.6</small>.</p>
	</div>

</body>
</html>

